---
page_title: "cloudflare_api_shield Resource - Cloudflare"
subcategory: ""
description: |-
  Provides a resource to manage API Shield configurations.
---

# cloudflare_api_shield (Resource)

Provides a resource to manage API Shield configurations.

## Example Usage

```terraform
resource "cloudflare_api_shield" "example" {
  zone_id = "0da42c8d2132a9ddaf714f9e7c920711"
  auth_id_characteristics {
    name = "my-example-header"
    type = "header"
  }
}
```
<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `zone_id` (String) The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**

### Optional

- `auth_id_characteristics` (Block List) Characteristics define properties across which auth-ids can be computed in a privacy-preserving manner. (see [below for nested schema](#nestedblock--auth_id_characteristics))

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--auth_id_characteristics"></a>
### Nested Schema for `auth_id_characteristics`

Optional:

- `name` (String) The name of the characteristic.
- `type` (String) The type of characteristic. Available values: `header`, `cookie`.


